import { get, post, postWithQueryParams } from "@/api/request";

/**
 * 角色控制器 / 角色控制器添加
 * @param {object} data
 * @param {string} [data.code] 角色编码
 * @param {string} [data.name] 角色名称
 * @param {string} [data.remark] 备注
 * @param {string} [data.scope] 适用范围 可选值: ALL, SYSTEM, TENANT
 * @param {string} [data.status] 状态 可选值: DISABLE, ENABLE
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<Role页面展示实体>}
 * @author 方昊
 */
export function systemRoleAdd(data, config) {
  return post("/system/role/add", data, config);
}

/**
 * 角色控制器 / 角色控制器查询所有角色
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<array<Role页面展示实体>>}
 * @author 方昊
 */
export function systemRoleAll(config) {
  return get("/system/role/all", config);
}

/**
 * 角色控制器 / 角色控制器角色授权菜单和按钮权限
 * @param {object} data
 * @param {number} [data.parentTenantId] 上级租户ID，如果是顶级租户，则传自己的ID
 * @param {array<string>} [data.permissionCode] 权限编码列表
 * @param {string} [data.roleCode] 角色编码
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<number>}
 * @author 方昊
 */
export function systemRoleAssignPermission(data, config) {
  return post("/system/role/assignPermission", data, config);
}

/**
 * 角色控制器 / 角色控制器角色关联用户
 * @param {object} data
 * @param {string} [data.parentTenantId] 上级租户ID，如果是顶级租户，则传自己的ID
 * @param {string} [data.roleCode] 角色编码
 * @param {array<number>} [data.userIds] 用户id
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<number>}
 * @author 方昊
 */
export function systemRoleAssignUser(data, config) {
  return post("/system/role/assignUser", data, config);
}

/**
 * 角色控制器 / 角色控制器批量取消租户角色关联用户
 * @param {object} data
 * @param {string} [data.parentTenantId] 上级租户ID，如果是顶级租户，则传自己的ID
 * @param {string} [data.roleCode] 角色编码
 * @param {array<number>} [data.userIds] 用户id
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<number>}
 */
export function systemRoleCancelUserRole(data, config) {
  return post("/system/role/cancelUserRole", data, config);
}

/**
 * 角色控制器 / 角色控制器删除
 * @param {object} params
 * @param {object} data
 * @param {number} params.id 角色ID
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<Role页面展示实体>}
 * @author 方昊
 */
export function systemRoleDelete(params, data, config) {
  return postWithQueryParams("/system/role/delete", params, data, config);
}

/**
 * 角色控制器 / 角色控制器查询详情
 * @param {object} params
 * @param {number} params.id 角色ID
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<Role页面展示实体>}
 * @author 方昊
 */
export function systemRoleDetail(params, config) {
  return get("/system/role/detail", params, config);
}

/**
 * 角色控制器 / 角色控制器分页查询
 * @param {object} data
 * @param {number} [data.length] 分页大小
 * @param {string} [data.name] 角色名称
 * @param {number} [data.orderAsc] 排序方向
 * @param {string} [data.orderColum] 排序字段
 * @param {number} [data.pageIndex] 分页下标
 * @param {number} [data.start] 查询记录起始下标
 * @param {string} [data.status] 状态 可选值: DISABLE, ENABLE
 * @param {number} [data.tenantId] 租户ID
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<分页返回实体<Role页面展示实体>>}
 * @author 方昊
 */
export function systemRoleList(data, config) {
  return post("/system/role/list", data, config);
}

/**
 * 角色控制器 / 角色控制器更新
 * @param {object} data
 * @param {string} [data.code] 角色编码
 * @param {string} [data.name] 角色名称
 * @param {string} [data.remark] 备注
 * @param {string} [data.scope] 适用范围 可选值: ALL, SYSTEM, TENANT
 * @param {string} [data.status] 状态 可选值: DISABLE, ENABLE
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<Role页面展示实体>}
 * @author 方昊
 */
export function systemRoleUpdate(data, config) {
  return post("/system/role/update", data, config);
}

/**
 * 角色控制器 / 角色控制器查询角色关联的用户
 * @param {object} data
 * @param {number} [data.length] 分页大小
 * @param {number} [data.orderAsc] 排序方向
 * @param {string} [data.orderColum] 排序字段
 * @param {number} [data.pageIndex] 分页下标
 * @param {string} [data.realName] 用户姓名
 * @param {number} [data.start] 查询记录起始下标
 * @param {string} [data.username] 用户账号
 * @param {import("axios").AxiosRequestConfig} [config]
 * @returns {Promise<array<Role页面展示实体>>}
 * @author 方昊
 */
export function systemRoleUser(data, config) {
  return post("/system/role/user", data, config);
}

/**
 * @template T
 * @typedef {Object} 分页返回实体
 * @property {T[]} content - 内容
 * @property {number} elementsNo
 * @property {number} limit
 * @property {number} number
 * @property {number} totalElements
 * @property {number} totalPages
 * @description 分页返回实体
 */

/**
 * @typedef {object} Permission页面展示实体 页面展示实体
 * @property {number} applicationId 应用ID
 * @property {object} attachment 附件页面展示实体
 * @property {string} attachment.attKey 附件key
 * @property {number} attachment.attOrder 附件排序
 * @property {number} attachment.attSize 附件大小(单位:MB)
 * @property {string} attachment.attSizeString 附件大小
 * @property {string} attachment.attSuffix 附件后缀
 * @property {string} attachment.attUrl 附件url
 * @property {string} attachment.attachmentType 文件类型
 * @property {string} attachment.createTime 创建时间
 * @property {string} attachment.createUser 创建用户
 * @property {boolean} attachment.delFlag 删除标识(false:否, true:是)
 * @property {number} attachment.directoryId 目录id
 * @property {number} attachment.id 主键
 * @property {string} attachment.originalName 原始文件名
 * @property {string} attachment.remark 备注
 * @property {string} attachment.updateTime 修改时间
 * @property {string} attachment.updateUser 修改用户
 * @property {string} btnIdentifying 按钮标识
 * @property {string} code 权限编码
 * @property {string} createTime 创建时间
 * @property {string} createUser 创建用户
 * @property {boolean} delFlag 删除标识(false:否, true:是)
 * @property {string} highlightUrl 高亮地址
 * @property {string} icon 菜单图标
 * @property {string} id 主键
 * @property {number} image 图片ID
 * @property {string} imageUrl 图片地址
 * @property {boolean} isBreadcrumbShow 是否显示在面包屑中（false不显示；true显示）
 * @property {boolean} isIndexShow 是否在首页显示
 * @property {boolean} isNavbarShow 是否显示在左侧导航栏中（false不显示；true显示）
 * @property {string} name 权限名称
 * @property {number} orderValue 排序值
 * @property {string} parameters 路由参数
 * @property {string} parentId 上级编码
 * @property {string} redirectUrl 重定向地址
 * @property {string} status 菜单状态 可选值: DISABLE, ENABLE
 * @property {string} type 权限类型 可选值: BUTTON, MENU
 * @property {string} updateTime 更新时间
 * @property {string} updateUser 更新用户
 * @property {string} url 路由地址
 * @description 页面展示实体
 */

/**
 * @typedef {object} Role页面展示实体 页面展示实体
 * @property {string} code 角色编码
 * @property {string} createTime 创建时间
 * @property {string} createUser 创建用户
 * @property {boolean} delFlag 删除状态（已删除true， 未删除false）
 * @property {string} id 主键
 * @property {string} name 角色名称
 * @property {string} parentTenantId 父租户ID
 * @property {array<Permission页面展示实体>} permissions 权限列表
 * @property {string} remark 备注
 * @property {string} scope 适用范围(1系统用户；2租户；3系统用户和租户) 可选值: ALL, SYSTEM, TENANT
 * @property {string} status 状态（0禁用，1启用） 可选值: DISABLE, ENABLE
 * @property {string} tenantId 租户ID
 * @property {string} type 角色类型 可选值: CUSTOM, SYSTEM
 * @property {string} updateTime 更新时间
 * @property {string} updateUser 更新用户
 * @description 页面展示实体
 */
